Skip to content

chore: update get transaction query params - #25

Merged
byjoh merged 2 commits into
developmentfrom
chore/update-get-transaction-query-params
Sep 30, 2025
Merged

byjoh merged 2 commits into
developmentfrom
chore/update-get-transaction-query-params

Conversation

@byjoh

@byjoh byjoh commented Sep 30, 2025 •

Copy link
Copy Markdown
Contributor

What is this PR doing?

This pull request enhances the transaction filtering capabilities of the get_transactions API, improves parameter validation, and updates integration and unit tests to ensure correct behavior for new and modified filters. The changes focus on allowing multi-status filtering, adding support for filtering transactions missing expense categories, and date filtering consistency. Additionally, parameter names and documentation are made more consistent.

API Filtering Improvements:

  • The status filter in get_transactions now accepts a sequence of statuses (e.g., multiple status values), and validates all provided values, raising a clear error for any invalid status. [1] [2]
  • Added the missing_expense_categories filter, allowing users to retrieve transactions missing required expense categories. [1] [2] [3]
  • Renaming parameters (fromDate/toDate → since/until) for consistency with api and updating integration tests to validate date range queries. [1] [2]

Parameter and Documentation Consistency:

  • Updated parameter names in the API request (perPage, since, until, etc.) and improved docstrings to accurately describe filter options and expected types. [1] [2] [3] [4]

Testing Enhancements:

  • Added new unit tests for the receipt_missing and missing_expense_categories filters to ensure correct API parameter mapping.
  • Expanded integration tests to cover multi-status filtering and date range filtering, ensuring the API behaves as expected for these scenarios.

Version Update:

  • Bumped the package version to 1.2.2 to reflect the new features and improvements.

Why do we need these changes?

Explain the reasoning behind these changes (feature, bug-fix, performance improvement, etc)

Additional Notes

Anything else you would like to note here.

@byjoh
byjoh requested review from a team as code owners September 30, 2025 22:38
@byjoh
byjoh requested a review from drumwell September 30, 2025 22:41
@byjoh
byjoh enabled auto-merge September 30, 2025 22:41
@byjoh
byjoh merged commit ec5b3ed into development Sep 30, 2025
4 checks passed
@byjoh
byjoh deleted the chore/update-get-transaction-query-params branch September 30, 2025 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants